/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package rx.android.plugins;

import rx.Scheduler;
import rx.android.schedulers.AndroidSchedulers;
import rx.functions.Action0;

public class RxAndroidSchedulersHook {
  private static final RxAndroidSchedulersHook DEFAULT_INSTANCE = new RxAndroidSchedulersHook();

  public static RxAndroidSchedulersHook getDefaultInstance() {
    return DEFAULT_INSTANCE;
  }

  /**
   * Scheduler to return from {@link AndroidSchedulers#mainThread()} or {@code null} if default
   * should be used.
   *
   * <p>This instance should be or behave like a stateless singleton.
   */
  public Scheduler getMainThreadScheduler() {
    return null;
  }

  /**
   * Invoked before the Action is handed over to the scheduler. Can be used for
   * wrapping/decorating/logging. The default is just a passthrough.
   *
   * @param action action to schedule
   * @return wrapped action to schedule
   */
  public Action0 onSchedule(Action0 action) {
    return action;
  }
}
